home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / terms / kermit / b / ckaaaa.hlp < prev    next >
Encoding:
Text File  |  1993-08-24  |  12.3 KB  |  308 lines
  1. CKAAAA.HLP                                                        June 30, 1993
  2.  
  3.          C-KERMIT VERSION 5A(189), OVERVIEW OF FILES
  4.  
  5.    Communications software for UNIX, (Open)VMS, OS/2, AOS/VS, Apollo Aegis,
  6.       OS-9, the Apple Macintosh, the Commodore Amiga, and the Atari ST.
  7.  
  8.  
  9. C-Kermit 5A(189) bears the following copyright notice:
  10.  
  11.   Copyright (C) 1985, 1993, Trustees of Columbia University in the City of New
  12.   York.  The C-Kermit software may not be, in whole or in part, licensed or
  13.   sold for profit as a software product itself, nor may it be included in or
  14.   distributed with commercial products or otherwise distributed by commercial
  15.   concerns to their clients or customers without written permission of the
  16.   Office of Kermit Development and Distribution, Columbia University.  This
  17.   copyright notice must not be removed, altered, or obscured.
  18.  
  19. And the following disclaimer:
  20.  
  21.   The C-Kermit software is provided in source code form by Kermit Development
  22.   and Distribution, Columbia University.  The software is provided "as is;" no
  23.   other warranty is provided, express or implied, including without
  24.   limitations, any implied warranty of merchantability or implied warranty of
  25.   fitness for a particular purpose.
  26.  
  27.   Neither Columbia University nor any of the contributors to the C-Kermit
  28.   development effort, including, but not limited to, AT&T, Digital Equipment
  29.   Corporation, Data General Corporation, or International Business Machines
  30.   Corporation, warrant C-Kermit software or documentation in any way.  In
  31.   addition, neither the authors of any Kermit programs, publications or
  32.   documentation, nor Columbia University nor any contributing institutions or
  33.   individuals acknowledge any liability resulting from program or
  34.   documentation errors.
  35.  
  36. DOCUMENTATION
  37.  
  38. C-Kermit 5A is documented in the book "Using C-Kermit" by Frank da Cruz
  39. and Christine M. Gianone, 1993, Digital Press, Burlington, MA, USA.  Digital
  40. Press ISBN: 1-55558-108-0; Prentice-Hall ISBN: 0-13-037490-3.  Price: US
  41. $34.95.  In USA, call DECdirect at 1-800-344-4825, refer to order number
  42. EY-J896E-DP.
  43.  
  44. FILES AND FILE NAMING CONVENTIONS
  45.  
  46. C-Kermit is a family of Kermit programs for many different computer systems.
  47. The program shares a common set of system-independent file transfer protocol
  48. modules, written in the C language.  System-dependent operations are collected
  49. into system-specific modules for each system, or in some cases, selected via
  50. conditional compilation (#ifdef) in the UNIX system dependent modules.
  51.  
  52. C-Kermit may be built for UNIX (BSD, AT&T, Ultrix, SUNOS, Xenix, many others),
  53. DEC VMS and OpenVMS on VAX and AXP computers, Data General AOS/VS, IBM OS/2,
  54. the Apple Macintosh, Apollo Aegis, the Commodore Amiga, the Atari ST, and
  55. Motorola 680x0 computers with Microware OS/9.
  56.  
  57. C-Kermit file names are of the form:
  58.  
  59.   CK<system><what>.<type>
  60.  
  61. where:
  62.  
  63. <type> is the file type (use lowercase on UNIX):
  64.  
  65.   C:   C language source
  66.   H:   Header file for C language source
  67.   W:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  68.   R:   Macintosh resource file (8-bit text)
  69.   A:   Assembler source
  70.  
  71.   ANN: The text of an announcement of a particular version
  72.   DOC: Documentation
  73.   HLP: Help text
  74.   NR:  Nroff/Troff text formatter source for UNIX "man page"
  75.   UPD: Program update history
  76.   BWR: A "beware" file - list of known bugs, limitations
  77.   MSS: Scribe text formatter source
  78.   PS:  Typeset material to be printed on a PostScript printer
  79.   DSK: A "read.me" file for diskette distributions
  80.  
  81.   INI: Initialization file
  82.   TAK: A Kermit TAKE command file
  83.   KDD: A Kermit Dialing Directory
  84.   KSD: A Kermit Services Directory
  85.   TXT: A plain-text file
  86.  
  87.   MAK: A Makefile or other build procedure (often needs renaming)
  88.   COM: (VMS only) a DCL command procedure
  89.   CMD: (OS/2 only) a Rexx command procedure
  90.   REL: (VMS only) a RELEASE_NOTES file
  91.  
  92.   BOO: "boo"-encoded executable program, decode with CKBUNB program.
  93.   HEX: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  94.   HQX: BinHex'd Macintosh Kermit program, decode with BinHex version 4.0.
  95.   UUE: A uuencoded binary file, decode with uudecode or (DG only) CKDECO.
  96.  
  97.   DEF: An OS/2 linker definitions file.
  98.   SED: A UNIX sed (editor) script.
  99.   STR: A file of character strings extracted from C-Kermit (BSD 2.1x).
  100.  
  101. <system> is a single character to tell what system the file applies to:
  102.  
  103.   A: General descriptive material and documentation
  104.   B: BOO file encoders and decoders
  105.   C: All systems with C compilers
  106.   D: Data General AOS/VS
  107.   E: Reserved for "ckermit" files, like CKERMIT.INI
  108.   F: Microsoft Windows 3.x (F = Fenster) (reserved)
  109.   H: Harris computers, VOS (reserved)
  110.   I: Commodore Amiga (Intuition)
  111.   J: (unused)
  112.   K: (unused)
  113.   L: Stratus VOS
  114.   M: Macintosh with Mac OS
  115.   N: Microsoft Windows NT (reserved)
  116.   O: OS/2
  117.   P: IBM PC, PS/2 with MS/PC-DOS (reserved)
  118.   Q: (unused)
  119.   R: DEC PDP-11 with RSTS/E (reserved)
  120.   S: Atari ST GEMDOS
  121.   T: DEC PDP-11 with RT-11 (reserved)
  122.   U: UNIX or environments with UNIX-like C libraries
  123.   V: VMS and OpenVMS
  124.   W: Wart (used with all systems)
  125.   X: DEC PDP-11 with RSX-11 (reserved)
  126.   Y: (unused)
  127.   Z: (unused)
  128.   0-8: (unused)
  129.   9: Microware OS-9
  130.  
  131. <what> is mnemonic (up to 3 characters) for what's in the file:
  132.  
  133.   AAA: A "read-me" file, like this one
  134.   INS: Installation instructions or procedures
  135.   KER: General C-Kermit definitions, information, documentation
  136.  
  137.   CMD: Command parsing
  138.   CON: CONNECT command
  139.   DEB: Debug/Transaction Log formats, Typedefs
  140.   DIA: Modem/Dialer control
  141.   FIO: System-depdendent File I/O
  142.   FNS: Protocol support functions
  143.   FN2: More protocol support functions (and FN3, ...)
  144.   MAI: Main program
  145.   PRO: Protocol
  146.   SCR: SCRIPT command
  147.   TIO: System-dependent communications i/o & control and interrupt handing
  148.   USR: User interface
  149.   US2: More user interface
  150.   US3: Still more user interface (and usr4, usr5, usr6, ...)
  151.   USX: Common user interface functions
  152.   USY: Command-line parsing
  153.   XLA: Character set translation module
  154.   NET: Network support module
  155.   MDB: Malloc-debugging module
  156.   STR: Strings module
  157.  
  158. Examples (use lowercase on UNIX):
  159.  
  160.   CKAAAA.HLP - This file
  161.   CKUFIO.C   - File i/o for UNIX
  162.   CKSTIO.C   - Communications i/o for the Atari ST
  163.   CKUKER.NR  - Nroff source file for UNIX C-Kermit man page
  164.   CKUKER.MAK - Makefile for building UNIX C-Kermit
  165.   CKOKER.MAK - Makefile for building OS/2 C-Kermit
  166.  
  167. IMPORTANT FILES (use lowercase names on UNIX):
  168.  
  169.   CKAAAA.HLP - This file (overview of the C-Kermit files).
  170.  
  171.   CKCKER.ANN - Brief list of new features of 5A (release announcements).
  172.   CKCKER.UPD - Updates: Supplement to "Using C-Kermit"
  173.   CKCKER.BWR - "Beware" file (limitations, known bugs, hints), general.
  174.   CKCCFG.DOC - Configuration information (feature selection), general.
  175.   CKCPLM.DOC - Program logic manual (for programmers)
  176.  
  177.   CKERMIT.INI - Standard initialization file (rename to .kermrc in UNIX, OS-9)
  178.   CKERMOD.INI - Sample customization file (rename to .mykermrc in UNIX, OS-9)
  179.   CKERMIT.KDD - Sample dialing directory file (rename to .kdd in UNIX, OS-9)
  180.   CKERMIT.KSD - Sample services directory file (rename to .ksd in UNIX, OS-9)
  181.   CKEDEMO.INI - Demonstration macros from "Using C-Kermit"
  182.   CKEVT.INI   - Ditto
  183.   CKETEST.INI - Ditto
  184.  
  185.   CKC189.UPD - Program update history for edit 189.
  186.   CKC188.UPD - Program update history, edits 179-188 (big)
  187.   CKC178.UPD - Program edit history, 5A edits through 178 (very big)
  188.   CKCV4F.UPD - Program edit history, version 4F
  189.   CKCV4E.UPD - Program edit history, version 4E
  190.  
  191.   CKUINS.DOC - UNIX-specific installation instructions
  192.   CKUKER.MAK - UNIX build procedure (also for Apollo Aegis)
  193.   CKUBS2.MAK - 2.10/2.11BSD build procedure
  194.   CKUKER.BWR - UNIX-specific beware file.
  195.   CKUKER.NR  - "man page" for UNIX
  196.  
  197.   CKVINS.DOC - VMS-specific installation instructions.
  198.   CKVKER.BWR - VMS-specific beware file
  199.   CKVKER.HLP - VMS C-Kermit HELP topic
  200.   CKVKER.COM - VMS build procedure (DCL)
  201.   CKVKER.MAK - VMS build procedure (MAKE)
  202.   CKVMSI.COM - VMSINSTAL-kit builder
  203.   CKVKIT.COM - VMSINSTAL-kit installer
  204.  
  205.   CKOAAA.DSK - READ.ME file for OS/2 C-Kermit distribution diskette
  206.   CKOINS.CMD - Rexx installation procedure for OS/2 C-Kermit
  207.   CKOKER.BWR - OS/2 "beware" file
  208.   CKOICON.BOO - BOO-encoded OS/2 C-Kermit icon
  209.  
  210.   CKDINS.DOC - Data General AOS/VS C-Kermit installation instructions
  211.   CKDKER.BWR - AOS/VS "beware" file
  212.  
  213. BINARIES
  214.  
  215. If you have FTP access to watsun.cc.columbia.edu (also known as
  216. kermit.cc.columbia.edu, ftp.cc.columbia.edu, kermit.columbia.edu, or
  217. ftp.columbia.edu), you can also retrieve various C-Kermit binaries from the
  218. directory kermit/bin/ck*.*.  Be sure to transfer these files in binary mode.
  219.  
  220. ENCODED BINARIES
  221.  
  222. VMS:
  223.  CKVKER.HEX  - VAX/VMS (OpenVMS) 5.5, no networks.  Decode with CKVDEH.MAR.
  224.  CKVAXP.HEX  - OpenVMS AXP 1.0, no networks.  Decode (on VAX) with CKVDEH.MAR.
  225.  CKVVTGV.HEX - VAX version with TGV MultiNet TCP/IP support included.
  226.  CKVVUCX.HEX - VAX version with DEC TCP/IP (UCX) support included.
  227.  CKVVWIN.HEX - VAX version with Wollongong WIN/TCP support included.
  228. OS-9:
  229.  CK9KER.BOO - OS-9/68000.  Decode with CKBUNB.C.
  230. OS/2:
  231.  CKOKER32.BOO - OS/2 2.00 (32-bit).  Decode with CKBUNB.C.
  232.  CKOKER16.BOO - OS/2 1.xx (16-bit).  Decode with CKBUNB.C.
  233. Amiga:
  234.  CKIKER.BOO.  Decode with CKBUNB.C.
  235. Atari ST:
  236.  CKSKER.BOO.  Decode with CKBUNB.C.
  237.  CKSNCP.BOO.  Minimal version of C-Kermit (no command parser).
  238. Data General MV AOS/VS:
  239.  CKDKER.UUE.  Decode with uudecode or ckdeco.c, then unpack with DUMPFILE.
  240.  
  241. SOURCE FILES
  242.  
  243. The source files for the UNIX version (all UNIX versions) are available in
  244. kermit/bin/cku189.tar.Z, approximately 777K in size.  Transfer this file in
  245. binary mode.  This is a compressed tar archive.  There is also a uuencoded
  246. version of it in kermit/b/cku189.uue (approx. 1MB, transfer in text mode).
  247. This archive does not contain the many supplementary files -- installation
  248. instructions, "beware files", etc, which you must acquire separately from
  249. kermit/b.  To get the binary tar archive:
  250.  
  251.   mkdir kermit                   (at shell prompt, make a Kermit directory)
  252.   cd kermit                      (make it your current directory)
  253.  
  254.   ftp watsun.cc.columbia.edu     (make an ftp connection)
  255.   user: anonymous                (log in as user "anonymous", lower case!)
  256.   password:                      (use your email id as a password)
  257.   cd kermit/bin                  (go to the kermit/bin directory)
  258.   type binary                    (specify binary file transfer)
  259.   get cku189.tar.Z               (get the tar archive)
  260.   bye                            (disconnect and exit from ftp)
  261.  
  262.   uncompress cku189.tar.Z        (at the shell prompt, uncompress the archive)
  263.   tar xvf cku189.tar             (extract the files from the tar archive)
  264.   make xxx                       (build C-Kermit for your system)
  265.  
  266. (where "xxx" is the makefile entry appropriate for your system.)
  267.  
  268. If you don't have ftp access, but are able to retrieve the uuencoded file
  269. (e.g. from an ftp mail server such as ftpmail@decwrl.dec.com), get the
  270. kermit/b/cku189.uue file in text mode and then:
  271.  
  272.   uudecode cku189.uue            (decode the archive into cku189.tar.Z)
  273.   rm cku189.uue                  (remove the uuencoded copy)
  274.   uncompress cku189.tar.Z        (at shell prompt, uncompress the archive)
  275.   tar xvf cku189.tar             (extract the files from the tar archive)
  276.   make xxx                       (build C-Kermit for your system)
  277.  
  278. All C-Kermit files are also kept separately in the kermit/b directory.
  279. The files necessary to build a particular implementation of C-Kermit
  280. are listed in the appropriate makefile or equivalent:
  281.  
  282.        UNIX: ckuker.mak (rename to makefile)
  283.    2.11 BSD: ckubs2.mak (rename to makefile), ckustr.sed
  284.   Macintosh: ckmker.mak (rename to kermit.make, use MPW C 3.2)
  285.         VMS: CKVKER.COM (DCL) or CKVKER.MAK (MAKE)
  286.       Amiga: CKIKER.MAK (Aztec C) or CKISAS.MAK (SAS C)
  287.    Atari ST: CKSKER.MAK
  288.        OS/2: CKOKER.MAK, CKOKER.DEF, CKWART.DEF (MSC 6.0, GCC, or IBM C Set/2)
  289.        OS-9: CK9KER.MAK or CK9KER.GCC
  290.      AOS/VS: CKDMAK.CLI, CKDCC.CLI, CKDLNK.CLI
  291.  
  292. Minimal source files for building selected versions (these patterns get all
  293. the files you need, and in some cases maybe a few extra):
  294.  
  295.    UNIX:   ck[cuw]*.[cwh]
  296.    VMS:    ck[cuwv]*.[cwh]
  297.    Mac:    ck[cuwm]*.[cwhr]
  298.    OS/2:   ck[cuwo]*.[cwh] ck*.def cko*.msb
  299.    AOS/VS: ck[cuwd]*.[cwh]
  300.    Amiga:  ck[cuwi]*.[cwh]
  301.    Atari:  ck[cuws]*.[cwh]
  302.    OS-9:   ck[cwh9]*.[cawh]
  303.  
  304. For a detailed, specific source file list for this C-Kermit release, see the
  305. file CKCxxx.UPD, where xxx is the C-Kermit edit number, such as 189.
  306.  
  307. (End of CKAAAA.HLP)
  308.